/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.control;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

/**
 * Exception used to indicate that a requested object was not found.
 *
 */
@ResponseStatus(value = HttpStatus.NOT_FOUND)
public class NotFoundException
extends RuntimeException
    {

    /**
     * Default message.
     *
     */
    public static final String DEFAULT_MESSAGE = "Unable to locate [{type}] with ident [{ident}]" ;

    /**
     * Message builder.
     *
     */
    public static String message(String type, String ident)
        {
        String message = DEFAULT_MESSAGE ;

        message = message.replace(
            "{type}",
            ((type != null) ? type : "null")
            );

        message = message.replace(
            "{ident}",
            ((ident != null) ? ident : "null")
            );

        return message ;
        }

    /**
     * Public constructor.
     *
     */
    public NotFoundException()
        {
        super();
        }

    /**
     * Public constructor.
     *
     */
    public NotFoundException(String type)
        {
        this(
            type,
            "null"
            );
        }

    /**
     * Public constructor.
     *
     */
    public NotFoundException(String type, Long ident)
        {
        this(
            type,
            ident.toString()
            );
        }

    /**
     * Public constructor.
     *
     */
    public NotFoundException(String type, String ident)
        {
        this(
            ident,
            type,
            message(
                type,
                ident
                )
            );
        }

    /**
     * Public constructor.
     *
     */
    public NotFoundException(String type, String ident, String message)
        {
        super(message);
        this.ident = ident ;
        this.type  = type  ;
        }

    /**
     * The type of the thing we were looking for.
     *
     */
    private String type ;

    /**
     * The type of the thing we were looking for.
     *
     */
    public String type()
        {
        return this.type ;
        }

    /**
     * The ident of the thing we were looking for.
     *
     */
    private String ident ;

    /**
     * The ident of the thing we were looking for.
     *
     */
    public String ident()
        {
        return this.ident ;
        }

    }

